aws-sdk-appsync 1.90.0 → 1.92.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-appsync/client.rb +668 -15
- data/lib/aws-sdk-appsync/client_api.rb +327 -2
- data/lib/aws-sdk-appsync/errors.rb +32 -0
- data/lib/aws-sdk-appsync/types.rb +662 -36
- data/lib/aws-sdk-appsync.rb +1 -1
- data/sig/client.rbs +220 -2
- data/sig/errors.rbs +6 -0
- data/sig/types.rbs +191 -1
- metadata +2 -2
@@ -53,6 +53,73 @@ module Aws::AppSync
|
|
53
53
|
include Aws::Structure
|
54
54
|
end
|
55
55
|
|
56
|
+
# Describes an AppSync API. You can use `Api` for an AppSync API with
|
57
|
+
# your preferred configuration, such as an Event API that provides
|
58
|
+
# real-time message publishing and message subscriptions over
|
59
|
+
# WebSockets.
|
60
|
+
#
|
61
|
+
# @!attribute [rw] api_id
|
62
|
+
# The `Api` ID.
|
63
|
+
# @return [String]
|
64
|
+
#
|
65
|
+
# @!attribute [rw] name
|
66
|
+
# The name of the `Api`.
|
67
|
+
# @return [String]
|
68
|
+
#
|
69
|
+
# @!attribute [rw] owner_contact
|
70
|
+
# The owner contact information for the `Api`
|
71
|
+
# @return [String]
|
72
|
+
#
|
73
|
+
# @!attribute [rw] tags
|
74
|
+
# A map with keys of `TagKey` objects and values of `TagValue`
|
75
|
+
# objects.
|
76
|
+
# @return [Hash<String,String>]
|
77
|
+
#
|
78
|
+
# @!attribute [rw] dns
|
79
|
+
# The DNS records for the API. This will include an HTTP and a
|
80
|
+
# real-time endpoint.
|
81
|
+
# @return [Hash<String,String>]
|
82
|
+
#
|
83
|
+
# @!attribute [rw] api_arn
|
84
|
+
# The Amazon Resource Name (ARN) for the `Api`.
|
85
|
+
# @return [String]
|
86
|
+
#
|
87
|
+
# @!attribute [rw] created
|
88
|
+
# The date and time that the `Api` was created.
|
89
|
+
# @return [Time]
|
90
|
+
#
|
91
|
+
# @!attribute [rw] xray_enabled
|
92
|
+
# A flag indicating whether to use X-Ray tracing for this `Api`.
|
93
|
+
# @return [Boolean]
|
94
|
+
#
|
95
|
+
# @!attribute [rw] waf_web_acl_arn
|
96
|
+
# The Amazon Resource Name (ARN) of the WAF web access control list
|
97
|
+
# (web ACL) associated with this `Api`, if one exists.
|
98
|
+
# @return [String]
|
99
|
+
#
|
100
|
+
# @!attribute [rw] event_config
|
101
|
+
# The Event API configuration. This includes the default authorization
|
102
|
+
# configuration for connecting, publishing, and subscribing to an
|
103
|
+
# Event API.
|
104
|
+
# @return [Types::EventConfig]
|
105
|
+
#
|
106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/Api AWS API Documentation
|
107
|
+
#
|
108
|
+
class Api < Struct.new(
|
109
|
+
:api_id,
|
110
|
+
:name,
|
111
|
+
:owner_contact,
|
112
|
+
:tags,
|
113
|
+
:dns,
|
114
|
+
:api_arn,
|
115
|
+
:created,
|
116
|
+
:xray_enabled,
|
117
|
+
:waf_web_acl_arn,
|
118
|
+
:event_config)
|
119
|
+
SENSITIVE = []
|
120
|
+
include Aws::Structure
|
121
|
+
end
|
122
|
+
|
56
123
|
# Describes an `ApiAssociation` object.
|
57
124
|
#
|
58
125
|
# @!attribute [rw] domain_name
|
@@ -468,6 +535,54 @@ module Aws::AppSync
|
|
468
535
|
include Aws::Structure
|
469
536
|
end
|
470
537
|
|
538
|
+
# Describes an authorization configuration. Use `AuthMode` to specify
|
539
|
+
# the publishing and subscription authorization configuration for an
|
540
|
+
# Event API.
|
541
|
+
#
|
542
|
+
# @!attribute [rw] auth_type
|
543
|
+
# The authorization type.
|
544
|
+
# @return [String]
|
545
|
+
#
|
546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/AuthMode AWS API Documentation
|
547
|
+
#
|
548
|
+
class AuthMode < Struct.new(
|
549
|
+
:auth_type)
|
550
|
+
SENSITIVE = []
|
551
|
+
include Aws::Structure
|
552
|
+
end
|
553
|
+
|
554
|
+
# Describes an authorization provider.
|
555
|
+
#
|
556
|
+
# @!attribute [rw] auth_type
|
557
|
+
# The authorization type.
|
558
|
+
# @return [String]
|
559
|
+
#
|
560
|
+
# @!attribute [rw] cognito_config
|
561
|
+
# Describes an Amazon Cognito user pool configuration.
|
562
|
+
# @return [Types::CognitoConfig]
|
563
|
+
#
|
564
|
+
# @!attribute [rw] open_id_connect_config
|
565
|
+
# Describes an OpenID Connect (OIDC) configuration.
|
566
|
+
# @return [Types::OpenIDConnectConfig]
|
567
|
+
#
|
568
|
+
# @!attribute [rw] lambda_authorizer_config
|
569
|
+
# A `LambdaAuthorizerConfig` specifies how to authorize AppSync API
|
570
|
+
# access when using the `AWS_LAMBDA` authorizer mode. Be aware that an
|
571
|
+
# AppSync API can have only one Lambda authorizer configured at a
|
572
|
+
# time.
|
573
|
+
# @return [Types::LambdaAuthorizerConfig]
|
574
|
+
#
|
575
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/AuthProvider AWS API Documentation
|
576
|
+
#
|
577
|
+
class AuthProvider < Struct.new(
|
578
|
+
:auth_type,
|
579
|
+
:cognito_config,
|
580
|
+
:open_id_connect_config,
|
581
|
+
:lambda_authorizer_config)
|
582
|
+
SENSITIVE = []
|
583
|
+
include Aws::Structure
|
584
|
+
end
|
585
|
+
|
471
586
|
# The authorization configuration in case the HTTP endpoint requires
|
472
587
|
# authorization.
|
473
588
|
#
|
@@ -579,6 +694,69 @@ module Aws::AppSync
|
|
579
694
|
include Aws::Structure
|
580
695
|
end
|
581
696
|
|
697
|
+
# Describes a channel namespace associated with an `Api`. The
|
698
|
+
# `ChannelNamespace` contains the definitions for code handlers for the
|
699
|
+
# `Api`.
|
700
|
+
#
|
701
|
+
# @!attribute [rw] api_id
|
702
|
+
# The `Api` ID.
|
703
|
+
# @return [String]
|
704
|
+
#
|
705
|
+
# @!attribute [rw] name
|
706
|
+
# The name of the channel namespace. This name must be unique within
|
707
|
+
# the `Api`.
|
708
|
+
# @return [String]
|
709
|
+
#
|
710
|
+
# @!attribute [rw] subscribe_auth_modes
|
711
|
+
# The authorization mode to use for subscribing to messages on the
|
712
|
+
# channel namespace. This configuration overrides the default
|
713
|
+
# `Api`authorization configuration.
|
714
|
+
# @return [Array<Types::AuthMode>]
|
715
|
+
#
|
716
|
+
# @!attribute [rw] publish_auth_modes
|
717
|
+
# The authorization mode to use for publishing messages on the channel
|
718
|
+
# namespace. This configuration overrides the default
|
719
|
+
# `Api`authorization configuration.
|
720
|
+
# @return [Array<Types::AuthMode>]
|
721
|
+
#
|
722
|
+
# @!attribute [rw] code_handlers
|
723
|
+
# The event handler functions that run custom business logic to
|
724
|
+
# process published events and subscribe requests.
|
725
|
+
# @return [String]
|
726
|
+
#
|
727
|
+
# @!attribute [rw] tags
|
728
|
+
# A map with keys of `TagKey` objects and values of `TagValue`
|
729
|
+
# objects.
|
730
|
+
# @return [Hash<String,String>]
|
731
|
+
#
|
732
|
+
# @!attribute [rw] channel_namespace_arn
|
733
|
+
# The Amazon Resource Name (ARN) for the `ChannelNamespace`.
|
734
|
+
# @return [String]
|
735
|
+
#
|
736
|
+
# @!attribute [rw] created
|
737
|
+
# The date and time that the `ChannelNamespace` was created.
|
738
|
+
# @return [Time]
|
739
|
+
#
|
740
|
+
# @!attribute [rw] last_modified
|
741
|
+
# The date and time that the `ChannelNamespace` was last changed.
|
742
|
+
# @return [Time]
|
743
|
+
#
|
744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ChannelNamespace AWS API Documentation
|
745
|
+
#
|
746
|
+
class ChannelNamespace < Struct.new(
|
747
|
+
:api_id,
|
748
|
+
:name,
|
749
|
+
:subscribe_auth_modes,
|
750
|
+
:publish_auth_modes,
|
751
|
+
:code_handlers,
|
752
|
+
:tags,
|
753
|
+
:channel_namespace_arn,
|
754
|
+
:created,
|
755
|
+
:last_modified)
|
756
|
+
SENSITIVE = []
|
757
|
+
include Aws::Structure
|
758
|
+
end
|
759
|
+
|
582
760
|
# Describes an AppSync error.
|
583
761
|
#
|
584
762
|
# @!attribute [rw] error_type
|
@@ -633,6 +811,32 @@ module Aws::AppSync
|
|
633
811
|
include Aws::Structure
|
634
812
|
end
|
635
813
|
|
814
|
+
# Describes an Amazon Cognito configuration.
|
815
|
+
#
|
816
|
+
# @!attribute [rw] user_pool_id
|
817
|
+
# The user pool ID.
|
818
|
+
# @return [String]
|
819
|
+
#
|
820
|
+
# @!attribute [rw] aws_region
|
821
|
+
# The Amazon Web Services Region in which the user pool was created.
|
822
|
+
# @return [String]
|
823
|
+
#
|
824
|
+
# @!attribute [rw] app_id_client_regex
|
825
|
+
# A regular expression for validating the incoming Amazon Cognito user
|
826
|
+
# pool app client ID. If this value isn't set, no filtering is
|
827
|
+
# applied.
|
828
|
+
# @return [String]
|
829
|
+
#
|
830
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CognitoConfig AWS API Documentation
|
831
|
+
#
|
832
|
+
class CognitoConfig < Struct.new(
|
833
|
+
:user_pool_id,
|
834
|
+
:aws_region,
|
835
|
+
:app_id_client_regex)
|
836
|
+
SENSITIVE = []
|
837
|
+
include Aws::Structure
|
838
|
+
end
|
839
|
+
|
636
840
|
# Describes an Amazon Cognito user pool configuration.
|
637
841
|
#
|
638
842
|
# @!attribute [rw] user_pool_id
|
@@ -673,6 +877,22 @@ module Aws::AppSync
|
|
673
877
|
include Aws::Structure
|
674
878
|
end
|
675
879
|
|
880
|
+
# A conflict with a previous successful update is detected. This
|
881
|
+
# typically occurs when the previous update did not have time to
|
882
|
+
# propagate before the next update was made. A retry (with appropriate
|
883
|
+
# backoff logic) is the recommended response to this exception.
|
884
|
+
#
|
885
|
+
# @!attribute [rw] message
|
886
|
+
# @return [String]
|
887
|
+
#
|
888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ConflictException AWS API Documentation
|
889
|
+
#
|
890
|
+
class ConflictException < Struct.new(
|
891
|
+
:message)
|
892
|
+
SENSITIVE = []
|
893
|
+
include Aws::Structure
|
894
|
+
end
|
895
|
+
|
676
896
|
# Represents the input of a `CreateApiCache` operation.
|
677
897
|
#
|
678
898
|
# @!attribute [rw] api_id
|
@@ -827,6 +1047,104 @@ module Aws::AppSync
|
|
827
1047
|
include Aws::Structure
|
828
1048
|
end
|
829
1049
|
|
1050
|
+
# @!attribute [rw] name
|
1051
|
+
# The name for the `Api`.
|
1052
|
+
# @return [String]
|
1053
|
+
#
|
1054
|
+
# @!attribute [rw] owner_contact
|
1055
|
+
# The owner contact information for the `Api`.
|
1056
|
+
# @return [String]
|
1057
|
+
#
|
1058
|
+
# @!attribute [rw] tags
|
1059
|
+
# A map with keys of `TagKey` objects and values of `TagValue`
|
1060
|
+
# objects.
|
1061
|
+
# @return [Hash<String,String>]
|
1062
|
+
#
|
1063
|
+
# @!attribute [rw] event_config
|
1064
|
+
# The Event API configuration. This includes the default authorization
|
1065
|
+
# configuration for connecting, publishing, and subscribing to an
|
1066
|
+
# Event API.
|
1067
|
+
# @return [Types::EventConfig]
|
1068
|
+
#
|
1069
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateApiRequest AWS API Documentation
|
1070
|
+
#
|
1071
|
+
class CreateApiRequest < Struct.new(
|
1072
|
+
:name,
|
1073
|
+
:owner_contact,
|
1074
|
+
:tags,
|
1075
|
+
:event_config)
|
1076
|
+
SENSITIVE = []
|
1077
|
+
include Aws::Structure
|
1078
|
+
end
|
1079
|
+
|
1080
|
+
# @!attribute [rw] api
|
1081
|
+
# The `Api` object.
|
1082
|
+
# @return [Types::Api]
|
1083
|
+
#
|
1084
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateApiResponse AWS API Documentation
|
1085
|
+
#
|
1086
|
+
class CreateApiResponse < Struct.new(
|
1087
|
+
:api)
|
1088
|
+
SENSITIVE = []
|
1089
|
+
include Aws::Structure
|
1090
|
+
end
|
1091
|
+
|
1092
|
+
# @!attribute [rw] api_id
|
1093
|
+
# The `Api` ID.
|
1094
|
+
# @return [String]
|
1095
|
+
#
|
1096
|
+
# @!attribute [rw] name
|
1097
|
+
# The name of the `ChannelNamespace`. This name must be unique within
|
1098
|
+
# the `Api`
|
1099
|
+
# @return [String]
|
1100
|
+
#
|
1101
|
+
# @!attribute [rw] subscribe_auth_modes
|
1102
|
+
# The authorization mode to use for subscribing to messages on the
|
1103
|
+
# channel namespace. This configuration overrides the default `Api`
|
1104
|
+
# authorization configuration.
|
1105
|
+
# @return [Array<Types::AuthMode>]
|
1106
|
+
#
|
1107
|
+
# @!attribute [rw] publish_auth_modes
|
1108
|
+
# The authorization mode to use for publishing messages on the channel
|
1109
|
+
# namespace. This configuration overrides the default `Api`
|
1110
|
+
# authorization configuration.
|
1111
|
+
# @return [Array<Types::AuthMode>]
|
1112
|
+
#
|
1113
|
+
# @!attribute [rw] code_handlers
|
1114
|
+
# The event handler functions that run custom business logic to
|
1115
|
+
# process published events and subscribe requests.
|
1116
|
+
# @return [String]
|
1117
|
+
#
|
1118
|
+
# @!attribute [rw] tags
|
1119
|
+
# A map with keys of `TagKey` objects and values of `TagValue`
|
1120
|
+
# objects.
|
1121
|
+
# @return [Hash<String,String>]
|
1122
|
+
#
|
1123
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateChannelNamespaceRequest AWS API Documentation
|
1124
|
+
#
|
1125
|
+
class CreateChannelNamespaceRequest < Struct.new(
|
1126
|
+
:api_id,
|
1127
|
+
:name,
|
1128
|
+
:subscribe_auth_modes,
|
1129
|
+
:publish_auth_modes,
|
1130
|
+
:code_handlers,
|
1131
|
+
:tags)
|
1132
|
+
SENSITIVE = []
|
1133
|
+
include Aws::Structure
|
1134
|
+
end
|
1135
|
+
|
1136
|
+
# @!attribute [rw] channel_namespace
|
1137
|
+
# The `ChannelNamespace` object.
|
1138
|
+
# @return [Types::ChannelNamespace]
|
1139
|
+
#
|
1140
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateChannelNamespaceResponse AWS API Documentation
|
1141
|
+
#
|
1142
|
+
class CreateChannelNamespaceResponse < Struct.new(
|
1143
|
+
:channel_namespace)
|
1144
|
+
SENSITIVE = []
|
1145
|
+
include Aws::Structure
|
1146
|
+
end
|
1147
|
+
|
830
1148
|
# @!attribute [rw] api_id
|
831
1149
|
# The API ID for the GraphQL API for the `DataSource`.
|
832
1150
|
# @return [String]
|
@@ -1085,13 +1403,6 @@ module Aws::AppSync
|
|
1085
1403
|
# Configuration for Lambda function authorization.
|
1086
1404
|
# @return [Types::LambdaAuthorizerConfig]
|
1087
1405
|
#
|
1088
|
-
# @!attribute [rw] visibility
|
1089
|
-
# Sets the value of the GraphQL API to public (`GLOBAL`) or private
|
1090
|
-
# (`PRIVATE`). If no value is provided, the visibility will be set to
|
1091
|
-
# `GLOBAL` by default. This value cannot be changed once the API has
|
1092
|
-
# been created.
|
1093
|
-
# @return [String]
|
1094
|
-
#
|
1095
1406
|
# @!attribute [rw] api_type
|
1096
1407
|
# The value that indicates whether the GraphQL API is a standard API
|
1097
1408
|
# (`GRAPHQL`) or merged API (`MERGED`).
|
@@ -1105,6 +1416,13 @@ module Aws::AppSync
|
|
1105
1416
|
# changes automatically.
|
1106
1417
|
# @return [String]
|
1107
1418
|
#
|
1419
|
+
# @!attribute [rw] visibility
|
1420
|
+
# Sets the value of the GraphQL API to public (`GLOBAL`) or private
|
1421
|
+
# (`PRIVATE`). If no value is provided, the visibility will be set to
|
1422
|
+
# `GLOBAL` by default. This value cannot be changed once the API has
|
1423
|
+
# been created.
|
1424
|
+
# @return [String]
|
1425
|
+
#
|
1108
1426
|
# @!attribute [rw] owner_contact
|
1109
1427
|
# The owner contact information for an API resource.
|
1110
1428
|
#
|
@@ -1164,9 +1482,9 @@ module Aws::AppSync
|
|
1164
1482
|
:additional_authentication_providers,
|
1165
1483
|
:xray_enabled,
|
1166
1484
|
:lambda_authorizer_config,
|
1167
|
-
:visibility,
|
1168
1485
|
:api_type,
|
1169
1486
|
:merged_api_execution_role_arn,
|
1487
|
+
:visibility,
|
1170
1488
|
:owner_contact,
|
1171
1489
|
:introspection_config,
|
1172
1490
|
:query_depth_limit,
|
@@ -1649,6 +1967,43 @@ module Aws::AppSync
|
|
1649
1967
|
#
|
1650
1968
|
class DeleteApiKeyResponse < Aws::EmptyStructure; end
|
1651
1969
|
|
1970
|
+
# @!attribute [rw] api_id
|
1971
|
+
# The `Api` ID.
|
1972
|
+
# @return [String]
|
1973
|
+
#
|
1974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/DeleteApiRequest AWS API Documentation
|
1975
|
+
#
|
1976
|
+
class DeleteApiRequest < Struct.new(
|
1977
|
+
:api_id)
|
1978
|
+
SENSITIVE = []
|
1979
|
+
include Aws::Structure
|
1980
|
+
end
|
1981
|
+
|
1982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/DeleteApiResponse AWS API Documentation
|
1983
|
+
#
|
1984
|
+
class DeleteApiResponse < Aws::EmptyStructure; end
|
1985
|
+
|
1986
|
+
# @!attribute [rw] api_id
|
1987
|
+
# The ID of the `Api` associated with the `ChannelNamespace`.
|
1988
|
+
# @return [String]
|
1989
|
+
#
|
1990
|
+
# @!attribute [rw] name
|
1991
|
+
# The name of the `ChannelNamespace`.
|
1992
|
+
# @return [String]
|
1993
|
+
#
|
1994
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/DeleteChannelNamespaceRequest AWS API Documentation
|
1995
|
+
#
|
1996
|
+
class DeleteChannelNamespaceRequest < Struct.new(
|
1997
|
+
:api_id,
|
1998
|
+
:name)
|
1999
|
+
SENSITIVE = []
|
2000
|
+
include Aws::Structure
|
2001
|
+
end
|
2002
|
+
|
2003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/DeleteChannelNamespaceResponse AWS API Documentation
|
2004
|
+
#
|
2005
|
+
class DeleteChannelNamespaceResponse < Aws::EmptyStructure; end
|
2006
|
+
|
1652
2007
|
# @!attribute [rw] api_id
|
1653
2008
|
# The API ID.
|
1654
2009
|
# @return [String]
|
@@ -2268,6 +2623,61 @@ module Aws::AppSync
|
|
2268
2623
|
include Aws::Structure
|
2269
2624
|
end
|
2270
2625
|
|
2626
|
+
# Describes the authorization configuration for connections, message
|
2627
|
+
# publishing, message subscriptions, and logging for an Event API.
|
2628
|
+
#
|
2629
|
+
# @!attribute [rw] auth_providers
|
2630
|
+
# A list of authorization providers.
|
2631
|
+
# @return [Array<Types::AuthProvider>]
|
2632
|
+
#
|
2633
|
+
# @!attribute [rw] connection_auth_modes
|
2634
|
+
# A list of valid authorization modes for the Event API connections.
|
2635
|
+
# @return [Array<Types::AuthMode>]
|
2636
|
+
#
|
2637
|
+
# @!attribute [rw] default_publish_auth_modes
|
2638
|
+
# A list of valid authorization modes for the Event API publishing.
|
2639
|
+
# @return [Array<Types::AuthMode>]
|
2640
|
+
#
|
2641
|
+
# @!attribute [rw] default_subscribe_auth_modes
|
2642
|
+
# A list of valid authorization modes for the Event API subscriptions.
|
2643
|
+
# @return [Array<Types::AuthMode>]
|
2644
|
+
#
|
2645
|
+
# @!attribute [rw] log_config
|
2646
|
+
# The CloudWatch Logs configuration for the Event API.
|
2647
|
+
# @return [Types::EventLogConfig]
|
2648
|
+
#
|
2649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/EventConfig AWS API Documentation
|
2650
|
+
#
|
2651
|
+
class EventConfig < Struct.new(
|
2652
|
+
:auth_providers,
|
2653
|
+
:connection_auth_modes,
|
2654
|
+
:default_publish_auth_modes,
|
2655
|
+
:default_subscribe_auth_modes,
|
2656
|
+
:log_config)
|
2657
|
+
SENSITIVE = []
|
2658
|
+
include Aws::Structure
|
2659
|
+
end
|
2660
|
+
|
2661
|
+
# Describes the CloudWatch Logs configuration for the Event API.
|
2662
|
+
#
|
2663
|
+
# @!attribute [rw] log_level
|
2664
|
+
# The type of information to log for the Event API.
|
2665
|
+
# @return [String]
|
2666
|
+
#
|
2667
|
+
# @!attribute [rw] cloud_watch_logs_role_arn
|
2668
|
+
# The IAM service role that AppSync assumes to publish CloudWatch Logs
|
2669
|
+
# in your account.
|
2670
|
+
# @return [String]
|
2671
|
+
#
|
2672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/EventLogConfig AWS API Documentation
|
2673
|
+
#
|
2674
|
+
class EventLogConfig < Struct.new(
|
2675
|
+
:log_level,
|
2676
|
+
:cloud_watch_logs_role_arn)
|
2677
|
+
SENSITIVE = []
|
2678
|
+
include Aws::Structure
|
2679
|
+
end
|
2680
|
+
|
2271
2681
|
# Represents the input of a `FlushApiCache` operation.
|
2272
2682
|
#
|
2273
2683
|
# @!attribute [rw] api_id
|
@@ -2420,6 +2830,59 @@ module Aws::AppSync
|
|
2420
2830
|
include Aws::Structure
|
2421
2831
|
end
|
2422
2832
|
|
2833
|
+
# @!attribute [rw] api_id
|
2834
|
+
# The `Api` ID.
|
2835
|
+
# @return [String]
|
2836
|
+
#
|
2837
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetApiRequest AWS API Documentation
|
2838
|
+
#
|
2839
|
+
class GetApiRequest < Struct.new(
|
2840
|
+
:api_id)
|
2841
|
+
SENSITIVE = []
|
2842
|
+
include Aws::Structure
|
2843
|
+
end
|
2844
|
+
|
2845
|
+
# @!attribute [rw] api
|
2846
|
+
# The `Api` object.
|
2847
|
+
# @return [Types::Api]
|
2848
|
+
#
|
2849
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetApiResponse AWS API Documentation
|
2850
|
+
#
|
2851
|
+
class GetApiResponse < Struct.new(
|
2852
|
+
:api)
|
2853
|
+
SENSITIVE = []
|
2854
|
+
include Aws::Structure
|
2855
|
+
end
|
2856
|
+
|
2857
|
+
# @!attribute [rw] api_id
|
2858
|
+
# The `Api` ID.
|
2859
|
+
# @return [String]
|
2860
|
+
#
|
2861
|
+
# @!attribute [rw] name
|
2862
|
+
# The name of the `ChannelNamespace`.
|
2863
|
+
# @return [String]
|
2864
|
+
#
|
2865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetChannelNamespaceRequest AWS API Documentation
|
2866
|
+
#
|
2867
|
+
class GetChannelNamespaceRequest < Struct.new(
|
2868
|
+
:api_id,
|
2869
|
+
:name)
|
2870
|
+
SENSITIVE = []
|
2871
|
+
include Aws::Structure
|
2872
|
+
end
|
2873
|
+
|
2874
|
+
# @!attribute [rw] channel_namespace
|
2875
|
+
# The `ChannelNamespace` object.
|
2876
|
+
# @return [Types::ChannelNamespace]
|
2877
|
+
#
|
2878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetChannelNamespaceResponse AWS API Documentation
|
2879
|
+
#
|
2880
|
+
class GetChannelNamespaceResponse < Struct.new(
|
2881
|
+
:channel_namespace)
|
2882
|
+
SENSITIVE = []
|
2883
|
+
include Aws::Structure
|
2884
|
+
end
|
2885
|
+
|
2423
2886
|
# @!attribute [rw] introspection_id
|
2424
2887
|
# The introspection ID. Each introspection contains a unique ID that
|
2425
2888
|
# can be used to reference the instrospection record.
|
@@ -2427,8 +2890,8 @@ module Aws::AppSync
|
|
2427
2890
|
#
|
2428
2891
|
# @!attribute [rw] include_models_sdl
|
2429
2892
|
# A boolean flag that determines whether SDL should be generated for
|
2430
|
-
# introspected types
|
2431
|
-
#
|
2893
|
+
# introspected types. If set to `true`, each model will contain an
|
2894
|
+
# `sdl` property that contains the SDL for that type. The SDL only
|
2432
2895
|
# contains the type data and no additional metadata or directives.
|
2433
2896
|
# @return [Boolean]
|
2434
2897
|
#
|
@@ -3135,6 +3598,87 @@ module Aws::AppSync
|
|
3135
3598
|
include Aws::Structure
|
3136
3599
|
end
|
3137
3600
|
|
3601
|
+
# @!attribute [rw] next_token
|
3602
|
+
# An identifier that was returned from the previous call to this
|
3603
|
+
# operation, which you can use to return the next set of items in the
|
3604
|
+
# list.
|
3605
|
+
# @return [String]
|
3606
|
+
#
|
3607
|
+
# @!attribute [rw] max_results
|
3608
|
+
# The maximum number of results that you want the request to return.
|
3609
|
+
# @return [Integer]
|
3610
|
+
#
|
3611
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListApisRequest AWS API Documentation
|
3612
|
+
#
|
3613
|
+
class ListApisRequest < Struct.new(
|
3614
|
+
:next_token,
|
3615
|
+
:max_results)
|
3616
|
+
SENSITIVE = []
|
3617
|
+
include Aws::Structure
|
3618
|
+
end
|
3619
|
+
|
3620
|
+
# @!attribute [rw] apis
|
3621
|
+
# The `Api` objects.
|
3622
|
+
# @return [Array<Types::Api>]
|
3623
|
+
#
|
3624
|
+
# @!attribute [rw] next_token
|
3625
|
+
# An identifier that was returned from the previous call to this
|
3626
|
+
# operation, which you can use to return the next set of items in the
|
3627
|
+
# list.
|
3628
|
+
# @return [String]
|
3629
|
+
#
|
3630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListApisResponse AWS API Documentation
|
3631
|
+
#
|
3632
|
+
class ListApisResponse < Struct.new(
|
3633
|
+
:apis,
|
3634
|
+
:next_token)
|
3635
|
+
SENSITIVE = []
|
3636
|
+
include Aws::Structure
|
3637
|
+
end
|
3638
|
+
|
3639
|
+
# @!attribute [rw] api_id
|
3640
|
+
# The `Api` ID.
|
3641
|
+
# @return [String]
|
3642
|
+
#
|
3643
|
+
# @!attribute [rw] next_token
|
3644
|
+
# An identifier that was returned from the previous call to this
|
3645
|
+
# operation, which you can use to return the next set of items in the
|
3646
|
+
# list.
|
3647
|
+
# @return [String]
|
3648
|
+
#
|
3649
|
+
# @!attribute [rw] max_results
|
3650
|
+
# The maximum number of results that you want the request to return.
|
3651
|
+
# @return [Integer]
|
3652
|
+
#
|
3653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListChannelNamespacesRequest AWS API Documentation
|
3654
|
+
#
|
3655
|
+
class ListChannelNamespacesRequest < Struct.new(
|
3656
|
+
:api_id,
|
3657
|
+
:next_token,
|
3658
|
+
:max_results)
|
3659
|
+
SENSITIVE = []
|
3660
|
+
include Aws::Structure
|
3661
|
+
end
|
3662
|
+
|
3663
|
+
# @!attribute [rw] channel_namespaces
|
3664
|
+
# The `ChannelNamespace` objects.
|
3665
|
+
# @return [Array<Types::ChannelNamespace>]
|
3666
|
+
#
|
3667
|
+
# @!attribute [rw] next_token
|
3668
|
+
# An identifier that was returned from the previous call to this
|
3669
|
+
# operation, which you can use to return the next set of items in the
|
3670
|
+
# list.
|
3671
|
+
# @return [String]
|
3672
|
+
#
|
3673
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListChannelNamespacesResponse AWS API Documentation
|
3674
|
+
#
|
3675
|
+
class ListChannelNamespacesResponse < Struct.new(
|
3676
|
+
:channel_namespaces,
|
3677
|
+
:next_token)
|
3678
|
+
SENSITIVE = []
|
3679
|
+
include Aws::Structure
|
3680
|
+
end
|
3681
|
+
|
3138
3682
|
# @!attribute [rw] api_id
|
3139
3683
|
# The API ID.
|
3140
3684
|
# @return [String]
|
@@ -3575,13 +4119,12 @@ module Aws::AppSync
|
|
3575
4119
|
# The Amazon CloudWatch Logs configuration.
|
3576
4120
|
#
|
3577
4121
|
# @!attribute [rw] field_log_level
|
3578
|
-
# The field logging level. Values can be NONE, ERROR,
|
3579
|
-
# ALL.
|
4122
|
+
# The field logging level. Values can be NONE, ERROR, or ALL.
|
3580
4123
|
#
|
3581
4124
|
# * **NONE**: No field-level logs are captured.
|
3582
4125
|
#
|
3583
|
-
# * **ERROR**: Logs the following information
|
3584
|
-
#
|
4126
|
+
# * **ERROR**: Logs the following information only for the fields that
|
4127
|
+
# are in error:
|
3585
4128
|
#
|
3586
4129
|
# * The error section in the server response.
|
3587
4130
|
#
|
@@ -3590,32 +4133,12 @@ module Aws::AppSync
|
|
3590
4133
|
# * The generated request/response functions that got resolved for
|
3591
4134
|
# error fields.
|
3592
4135
|
#
|
3593
|
-
# * **INFO**: Logs the following information **only** for the fields
|
3594
|
-
# that are in the info and error categories:
|
3595
|
-
#
|
3596
|
-
# * Info-level messages.
|
3597
|
-
#
|
3598
|
-
# * The user messages sent through `$util.log.info` and
|
3599
|
-
# `console.log`.
|
3600
|
-
#
|
3601
|
-
# * Field-level tracing and mapping logs are not shown.
|
3602
|
-
#
|
3603
|
-
# * **DEBUG**: Logs the following information **only** for the fields
|
3604
|
-
# that are in the debug, info, and error categories:
|
3605
|
-
#
|
3606
|
-
# * Debug-level messages.
|
3607
|
-
#
|
3608
|
-
# * The user messages sent through `$util.log.info`,
|
3609
|
-
# `$util.log.debug`, `console.log`, and `console.debug`.
|
3610
|
-
#
|
3611
|
-
# * Field-level tracing and mapping logs are not shown.
|
3612
|
-
#
|
3613
4136
|
# * **ALL**: The following information is logged for all fields in the
|
3614
4137
|
# query:
|
3615
4138
|
#
|
3616
4139
|
# * Field-level tracing information.
|
3617
4140
|
#
|
3618
|
-
# * The generated request/response functions that
|
4141
|
+
# * The generated request/response functions that got resolved for
|
3619
4142
|
# each field.
|
3620
4143
|
# @return [String]
|
3621
4144
|
#
|
@@ -3747,7 +4270,7 @@ module Aws::AppSync
|
|
3747
4270
|
#
|
3748
4271
|
# You can create a list of environmental variables by adding it to the
|
3749
4272
|
# `environmentVariables` payload as a list in the format
|
3750
|
-
#
|
4273
|
+
# `{"key1":"value1","key2":"value2", …}`. Note that each call of the
|
3751
4274
|
# `PutGraphqlApiEnvironmentVariables` action will result in the
|
3752
4275
|
# overwriting of the existing environmental variable list of that API.
|
3753
4276
|
# This means the existing environmental variables will be lost. To
|
@@ -3966,6 +4489,19 @@ module Aws::AppSync
|
|
3966
4489
|
include Aws::Structure
|
3967
4490
|
end
|
3968
4491
|
|
4492
|
+
# The operation exceeded the service quota for this resource.
|
4493
|
+
#
|
4494
|
+
# @!attribute [rw] message
|
4495
|
+
# @return [String]
|
4496
|
+
#
|
4497
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ServiceQuotaExceededException AWS API Documentation
|
4498
|
+
#
|
4499
|
+
class ServiceQuotaExceededException < Struct.new(
|
4500
|
+
:message)
|
4501
|
+
SENSITIVE = []
|
4502
|
+
include Aws::Structure
|
4503
|
+
end
|
4504
|
+
|
3969
4505
|
# Describes the configuration of a source API. A source API is a GraphQL
|
3970
4506
|
# API that is linked to a merged API. There can be multiple source APIs
|
3971
4507
|
# attached to each merged API. When linked to a merged API, the source
|
@@ -4504,6 +5040,96 @@ module Aws::AppSync
|
|
4504
5040
|
include Aws::Structure
|
4505
5041
|
end
|
4506
5042
|
|
5043
|
+
# @!attribute [rw] api_id
|
5044
|
+
# The `Api` ID.
|
5045
|
+
# @return [String]
|
5046
|
+
#
|
5047
|
+
# @!attribute [rw] name
|
5048
|
+
# The name of the Api.
|
5049
|
+
# @return [String]
|
5050
|
+
#
|
5051
|
+
# @!attribute [rw] owner_contact
|
5052
|
+
# The owner contact information for the `Api`.
|
5053
|
+
# @return [String]
|
5054
|
+
#
|
5055
|
+
# @!attribute [rw] event_config
|
5056
|
+
# The new event configuration. This includes the default authorization
|
5057
|
+
# configuration for connecting, publishing, and subscribing to an
|
5058
|
+
# Event API.
|
5059
|
+
# @return [Types::EventConfig]
|
5060
|
+
#
|
5061
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateApiRequest AWS API Documentation
|
5062
|
+
#
|
5063
|
+
class UpdateApiRequest < Struct.new(
|
5064
|
+
:api_id,
|
5065
|
+
:name,
|
5066
|
+
:owner_contact,
|
5067
|
+
:event_config)
|
5068
|
+
SENSITIVE = []
|
5069
|
+
include Aws::Structure
|
5070
|
+
end
|
5071
|
+
|
5072
|
+
# @!attribute [rw] api
|
5073
|
+
# The `Api` object.
|
5074
|
+
# @return [Types::Api]
|
5075
|
+
#
|
5076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateApiResponse AWS API Documentation
|
5077
|
+
#
|
5078
|
+
class UpdateApiResponse < Struct.new(
|
5079
|
+
:api)
|
5080
|
+
SENSITIVE = []
|
5081
|
+
include Aws::Structure
|
5082
|
+
end
|
5083
|
+
|
5084
|
+
# @!attribute [rw] api_id
|
5085
|
+
# The `Api` ID.
|
5086
|
+
# @return [String]
|
5087
|
+
#
|
5088
|
+
# @!attribute [rw] name
|
5089
|
+
# The name of the `ChannelNamespace`.
|
5090
|
+
# @return [String]
|
5091
|
+
#
|
5092
|
+
# @!attribute [rw] subscribe_auth_modes
|
5093
|
+
# The authorization mode to use for subscribing to messages on the
|
5094
|
+
# channel namespace. This configuration overrides the default `Api`
|
5095
|
+
# authorization configuration.
|
5096
|
+
# @return [Array<Types::AuthMode>]
|
5097
|
+
#
|
5098
|
+
# @!attribute [rw] publish_auth_modes
|
5099
|
+
# The authorization mode to use for publishing messages on the channel
|
5100
|
+
# namespace. This configuration overrides the default `Api`
|
5101
|
+
# authorization configuration.
|
5102
|
+
# @return [Array<Types::AuthMode>]
|
5103
|
+
#
|
5104
|
+
# @!attribute [rw] code_handlers
|
5105
|
+
# The event handler functions that run custom business logic to
|
5106
|
+
# process published events and subscribe requests.
|
5107
|
+
# @return [String]
|
5108
|
+
#
|
5109
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateChannelNamespaceRequest AWS API Documentation
|
5110
|
+
#
|
5111
|
+
class UpdateChannelNamespaceRequest < Struct.new(
|
5112
|
+
:api_id,
|
5113
|
+
:name,
|
5114
|
+
:subscribe_auth_modes,
|
5115
|
+
:publish_auth_modes,
|
5116
|
+
:code_handlers)
|
5117
|
+
SENSITIVE = []
|
5118
|
+
include Aws::Structure
|
5119
|
+
end
|
5120
|
+
|
5121
|
+
# @!attribute [rw] channel_namespace
|
5122
|
+
# The `ChannelNamespace` object.
|
5123
|
+
# @return [Types::ChannelNamespace]
|
5124
|
+
#
|
5125
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateChannelNamespaceResponse AWS API Documentation
|
5126
|
+
#
|
5127
|
+
class UpdateChannelNamespaceResponse < Struct.new(
|
5128
|
+
:channel_namespace)
|
5129
|
+
SENSITIVE = []
|
5130
|
+
include Aws::Structure
|
5131
|
+
end
|
5132
|
+
|
4507
5133
|
# @!attribute [rw] api_id
|
4508
5134
|
# The API ID.
|
4509
5135
|
# @return [String]
|