Table of Contents
ElasticBeanstalk.
Client
¶A low-level client representing AWS Elastic Beanstalk:
client = session.create_client('elasticbeanstalk')
These are the available methods:
abort_environment_update()
can_paginate()
check_dns_availability()
create_application()
create_application_version()
create_configuration_template()
create_environment()
create_storage_location()
delete_application()
delete_application_version()
delete_configuration_template()
delete_environment_configuration()
describe_application_versions()
describe_applications()
describe_configuration_options()
describe_configuration_settings()
describe_environment_resources()
describe_environments()
describe_events()
generate_presigned_url()
get_paginator()
get_waiter()
list_available_solution_stacks()
rebuild_environment()
request_environment_info()
restart_app_server()
retrieve_environment_info()
swap_environment_cnames()
terminate_environment()
update_application()
update_application_version()
update_configuration_template()
update_environment()
validate_configuration_settings()
abort_environment_update
(**kwargs)¶Cancels in-progress environment configuration update or application version deployment.
Request Syntax
response = client.abort_environment_update(
EnvironmentId='string',
EnvironmentName='string'
)
Parameters: |
|
---|---|
Returns: | None |
can_paginate
(operation_name)¶Check if an operation can be paginated.
Parameters: | operation_name (string) -- The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo , and you'd normally invoke the
operation as client.create_foo(**kwargs) , if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo") . |
---|---|
Returns: | True if the operation can be paginated,
False otherwise. |
check_dns_availability
(**kwargs)¶Checks if the specified CNAME is available.
Request Syntax
response = client.check_dns_availability(
CNAMEPrefix='string'
)
Parameters: | CNAMEPrefix (string) -- [REQUIRED] The prefix used when this CNAME is reserved. |
---|---|
Return type: | dict |
Returns: | Response Syntax{
'Available': True|False,
'FullyQualifiedCNAME': 'string'
}
Response Structure
|
create_application
(**kwargs)¶Creates an application that has one configuration template named default
and no application versions.
Request Syntax
response = client.create_application(
ApplicationName='string',
Description='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'Application': {
'ApplicationName': 'string',
'Description': 'string',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'Versions': [
'string',
],
'ConfigurationTemplates': [
'string',
]
}
}
Response Structure
|
create_application_version
(**kwargs)¶Creates an application version for the specified application.
Note
Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.
Request Syntax
response = client.create_application_version(
ApplicationName='string',
VersionLabel='string',
Description='string',
SourceBundle={
'S3Bucket': 'string',
'S3Key': 'string'
},
AutoCreateApplication=True|False
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'ApplicationVersion': {
'ApplicationName': 'string',
'Description': 'string',
'VersionLabel': 'string',
'SourceBundle': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1)
}
}
Response Structure
|
create_configuration_template
(**kwargs)¶Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.
Related Topics
Request Syntax
response = client.create_configuration_template(
ApplicationName='string',
TemplateName='string',
SolutionStackName='string',
SourceConfiguration={
'ApplicationName': 'string',
'TemplateName': 'string'
},
EnvironmentId='string',
Description='string',
OptionSettings=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
]
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'SolutionStackName': 'string',
'ApplicationName': 'string',
'TemplateName': 'string',
'Description': 'string',
'EnvironmentName': 'string',
'DeploymentStatus': 'deployed'|'pending'|'failed',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'OptionSettings': [
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
]
}
Response Structure
|
create_environment
(**kwargs)¶Launches an environment for the specified application using the specified configuration.
Request Syntax
response = client.create_environment(
ApplicationName='string',
EnvironmentName='string',
Description='string',
CNAMEPrefix='string',
Tier={
'Name': 'string',
'Type': 'string',
'Version': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
VersionLabel='string',
TemplateName='string',
SolutionStackName='string',
OptionSettings=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
],
OptionsToRemove=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string'
},
]
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'EnvironmentName': 'string',
'EnvironmentId': 'string',
'ApplicationName': 'string',
'VersionLabel': 'string',
'SolutionStackName': 'string',
'TemplateName': 'string',
'Description': 'string',
'EndpointURL': 'string',
'CNAME': 'string',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'Status': 'Launching'|'Updating'|'Ready'|'Terminating'|'Terminated',
'AbortableOperationInProgress': True|False,
'Health': 'Green'|'Yellow'|'Red'|'Grey',
'Resources': {
'LoadBalancer': {
'LoadBalancerName': 'string',
'Domain': 'string',
'Listeners': [
{
'Protocol': 'string',
'Port': 123
},
]
}
},
'Tier': {
'Name': 'string',
'Type': 'string',
'Version': 'string'
}
}
Response Structure
|
create_storage_location
()¶Creates the Amazon S3 storage location for the account.
This location is used to store user log files.
Request Syntax
response = client.create_storage_location()
Return type: | dict |
---|---|
Returns: | Response Syntax{
'S3Bucket': 'string'
}
Response Structure
|
delete_application
(**kwargs)¶Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.
Note
You cannot delete an application that has a running environment.
Request Syntax
response = client.delete_application(
ApplicationName='string',
TerminateEnvByForce=True|False
)
Parameters: |
|
---|---|
Returns: | None |
delete_application_version
(**kwargs)¶Deletes the specified version from the specified application.
Note
You cannot delete an application version that is associated with a running environment.
Request Syntax
response = client.delete_application_version(
ApplicationName='string',
VersionLabel='string',
DeleteSourceBundle=True|False
)
Parameters: |
|
---|---|
Returns: | None |
delete_configuration_template
(**kwargs)¶Deletes the specified configuration template.
Note
When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.
Request Syntax
response = client.delete_configuration_template(
ApplicationName='string',
TemplateName='string'
)
Parameters: |
|
---|---|
Returns: | None |
delete_environment_configuration
(**kwargs)¶Deletes the draft configuration associated with the running environment.
Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus
for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.
Request Syntax
response = client.delete_environment_configuration(
ApplicationName='string',
EnvironmentName='string'
)
Parameters: |
|
---|---|
Returns: | None |
describe_application_versions
(**kwargs)¶Returns descriptions for existing application versions.
Request Syntax
response = client.describe_application_versions(
ApplicationName='string',
VersionLabels=[
'string',
]
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'ApplicationVersions': [
{
'ApplicationName': 'string',
'Description': 'string',
'VersionLabel': 'string',
'SourceBundle': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1)
},
]
}
Response Structure
|
describe_applications
(**kwargs)¶Returns the descriptions of existing applications.
Request Syntax
response = client.describe_applications(
ApplicationNames=[
'string',
]
)
Parameters: | ApplicationNames (list) -- If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.
|
---|---|
Return type: | dict |
Returns: | Response Syntax{
'Applications': [
{
'ApplicationName': 'string',
'Description': 'string',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'Versions': [
'string',
],
'ConfigurationTemplates': [
'string',
]
},
]
}
Response Structure
|
describe_configuration_options
(**kwargs)¶Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.
Request Syntax
response = client.describe_configuration_options(
ApplicationName='string',
TemplateName='string',
EnvironmentName='string',
SolutionStackName='string',
Options=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string'
},
]
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'SolutionStackName': 'string',
'Options': [
{
'Namespace': 'string',
'Name': 'string',
'DefaultValue': 'string',
'ChangeSeverity': 'string',
'UserDefined': True|False,
'ValueType': 'Scalar'|'List',
'ValueOptions': [
'string',
],
'MinValue': 123,
'MaxValue': 123,
'MaxLength': 123,
'Regex': {
'Pattern': 'string',
'Label': 'string'
}
},
]
}
Response Structure
|
describe_configuration_settings
(**kwargs)¶Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.
When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.
Related Topics
Request Syntax
response = client.describe_configuration_settings(
ApplicationName='string',
TemplateName='string',
EnvironmentName='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'ConfigurationSettings': [
{
'SolutionStackName': 'string',
'ApplicationName': 'string',
'TemplateName': 'string',
'Description': 'string',
'EnvironmentName': 'string',
'DeploymentStatus': 'deployed'|'pending'|'failed',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'OptionSettings': [
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
|
describe_environment_resources
(**kwargs)¶Returns AWS resources for this environment.
Request Syntax
response = client.describe_environment_resources(
EnvironmentId='string',
EnvironmentName='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'EnvironmentResources': {
'EnvironmentName': 'string',
'AutoScalingGroups': [
{
'Name': 'string'
},
],
'Instances': [
{
'Id': 'string'
},
],
'LaunchConfigurations': [
{
'Name': 'string'
},
],
'LoadBalancers': [
{
'Name': 'string'
},
],
'Triggers': [
{
'Name': 'string'
},
],
'Queues': [
{
'Name': 'string',
'URL': 'string'
},
]
}
}
Response Structure
|
describe_environments
(**kwargs)¶Returns descriptions for existing environments.
Request Syntax
response = client.describe_environments(
ApplicationName='string',
VersionLabel='string',
EnvironmentIds=[
'string',
],
EnvironmentNames=[
'string',
],
IncludeDeleted=True|False,
IncludedDeletedBackTo=datetime(2015, 1, 1)
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'Environments': [
{
'EnvironmentName': 'string',
'EnvironmentId': 'string',
'ApplicationName': 'string',
'VersionLabel': 'string',
'SolutionStackName': 'string',
'TemplateName': 'string',
'Description': 'string',
'EndpointURL': 'string',
'CNAME': 'string',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'Status': 'Launching'|'Updating'|'Ready'|'Terminating'|'Terminated',
'AbortableOperationInProgress': True|False,
'Health': 'Green'|'Yellow'|'Red'|'Grey',
'Resources': {
'LoadBalancer': {
'LoadBalancerName': 'string',
'Domain': 'string',
'Listeners': [
{
'Protocol': 'string',
'Port': 123
},
]
}
},
'Tier': {
'Name': 'string',
'Type': 'string',
'Version': 'string'
}
},
]
}
Response Structure
|
describe_events
(**kwargs)¶Returns list of event descriptions matching criteria up to the last 6 weeks.
Note
This action returns the most recent 1,000 events from the specified NextToken
.
Request Syntax
response = client.describe_events(
ApplicationName='string',
VersionLabel='string',
TemplateName='string',
EnvironmentId='string',
EnvironmentName='string',
RequestId='string',
Severity='TRACE'|'DEBUG'|'INFO'|'WARN'|'ERROR'|'FATAL',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
MaxRecords=123,
NextToken='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'Events': [
{
'EventDate': datetime(2015, 1, 1),
'Message': 'string',
'ApplicationName': 'string',
'VersionLabel': 'string',
'TemplateName': 'string',
'EnvironmentName': 'string',
'RequestId': 'string',
'Severity': 'TRACE'|'DEBUG'|'INFO'|'WARN'|'ERROR'|'FATAL'
},
],
'NextToken': 'string'
}
Response Structure
|
generate_presigned_url
(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
Parameters: |
|
---|---|
Returns: | The presigned url |
get_paginator
(operation_name)¶Create a paginator for an operation.
Parameters: | operation_name (string) -- The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo , and you'd normally invoke the
operation as client.create_foo(**kwargs) , if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo") . |
---|---|
Raises OperationNotPageableError: | |
Raised if the operation is not
pageable. You can use the client.can_paginate method to
check if an operation is pageable. |
|
Return type: | L{botocore.paginate.Paginator} |
Returns: | A paginator object. |
get_waiter
(waiter_name)¶list_available_solution_stacks
()¶Returns a list of the available solution stack names.
Request Syntax
response = client.list_available_solution_stacks()
Return type: | dict |
---|---|
Returns: | Response Syntax{
'SolutionStacks': [
'string',
],
'SolutionStackDetails': [
{
'SolutionStackName': 'string',
'PermittedFileTypes': [
'string',
]
},
]
}
Response Structure
|
rebuild_environment
(**kwargs)¶Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.
Request Syntax
response = client.rebuild_environment(
EnvironmentId='string',
EnvironmentName='string'
)
Parameters: |
|
---|---|
Returns: | None |
request_environment_info
(**kwargs)¶Initiates a request to compile the specified type of information of the deployed environment.
Setting the InfoType
to tail
compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.
Setting the InfoType
to bundle
compresses the application server log files for every Amazon EC2 instance into a .zip
file. Legacy and .NET containers do not support bundle logs.
Use RetrieveEnvironmentInfo to obtain the set of logs.
Related Topics
Request Syntax
response = client.request_environment_info(
EnvironmentId='string',
EnvironmentName='string',
InfoType='tail'|'bundle'
)
Parameters: |
|
---|---|
Returns: | None |
restart_app_server
(**kwargs)¶Causes the environment to restart the application container server running on each Amazon EC2 instance.
Request Syntax
response = client.restart_app_server(
EnvironmentId='string',
EnvironmentName='string'
)
Parameters: |
|
---|---|
Returns: | None |
retrieve_environment_info
(**kwargs)¶Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
Request Syntax
response = client.retrieve_environment_info(
EnvironmentId='string',
EnvironmentName='string',
InfoType='tail'|'bundle'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'EnvironmentInfo': [
{
'InfoType': 'tail'|'bundle',
'Ec2InstanceId': 'string',
'SampleTimestamp': datetime(2015, 1, 1),
'Message': 'string'
},
]
}
Response Structure
|
swap_environment_cnames
(**kwargs)¶Swaps the CNAMEs of two environments.
Request Syntax
response = client.swap_environment_cnames(
SourceEnvironmentId='string',
SourceEnvironmentName='string',
DestinationEnvironmentId='string',
DestinationEnvironmentName='string'
)
Parameters: |
|
---|---|
Returns: | None |
terminate_environment
(**kwargs)¶Terminates the specified environment.
Request Syntax
response = client.terminate_environment(
EnvironmentId='string',
EnvironmentName='string',
TerminateResources=True|False
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'EnvironmentName': 'string',
'EnvironmentId': 'string',
'ApplicationName': 'string',
'VersionLabel': 'string',
'SolutionStackName': 'string',
'TemplateName': 'string',
'Description': 'string',
'EndpointURL': 'string',
'CNAME': 'string',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'Status': 'Launching'|'Updating'|'Ready'|'Terminating'|'Terminated',
'AbortableOperationInProgress': True|False,
'Health': 'Green'|'Yellow'|'Red'|'Grey',
'Resources': {
'LoadBalancer': {
'LoadBalancerName': 'string',
'Domain': 'string',
'Listeners': [
{
'Protocol': 'string',
'Port': 123
},
]
}
},
'Tier': {
'Name': 'string',
'Type': 'string',
'Version': 'string'
}
}
Response Structure
|
update_application
(**kwargs)¶Updates the specified application to have the specified properties.
Note
If a property (for example, description
) is not provided, the value remains unchanged. To clear these properties, specify an empty string.
Request Syntax
response = client.update_application(
ApplicationName='string',
Description='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'Application': {
'ApplicationName': 'string',
'Description': 'string',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'Versions': [
'string',
],
'ConfigurationTemplates': [
'string',
]
}
}
Response Structure
|
update_application_version
(**kwargs)¶Updates the specified application version to have the specified properties.
Note
If a property (for example, description
) is not provided, the value remains unchanged. To clear properties, specify an empty string.
Request Syntax
response = client.update_application_version(
ApplicationName='string',
VersionLabel='string',
Description='string'
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'ApplicationVersion': {
'ApplicationName': 'string',
'Description': 'string',
'VersionLabel': 'string',
'SourceBundle': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1)
}
}
Response Structure
|
update_configuration_template
(**kwargs)¶Updates the specified configuration template to have the specified properties or configuration option values.
Note
If a property (for example, ApplicationName
) is not provided, its value remains unchanged. To clear such properties, specify an empty string.
Related Topics
Request Syntax
response = client.update_configuration_template(
ApplicationName='string',
TemplateName='string',
Description='string',
OptionSettings=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
],
OptionsToRemove=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string'
},
]
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'SolutionStackName': 'string',
'ApplicationName': 'string',
'TemplateName': 'string',
'Description': 'string',
'EnvironmentName': 'string',
'DeploymentStatus': 'deployed'|'pending'|'failed',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'OptionSettings': [
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
]
}
Response Structure
|
update_environment
(**kwargs)¶Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.
Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination
error.
When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus
values.
Request Syntax
response = client.update_environment(
EnvironmentId='string',
EnvironmentName='string',
Description='string',
Tier={
'Name': 'string',
'Type': 'string',
'Version': 'string'
},
VersionLabel='string',
TemplateName='string',
SolutionStackName='string',
OptionSettings=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
],
OptionsToRemove=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string'
},
]
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'EnvironmentName': 'string',
'EnvironmentId': 'string',
'ApplicationName': 'string',
'VersionLabel': 'string',
'SolutionStackName': 'string',
'TemplateName': 'string',
'Description': 'string',
'EndpointURL': 'string',
'CNAME': 'string',
'DateCreated': datetime(2015, 1, 1),
'DateUpdated': datetime(2015, 1, 1),
'Status': 'Launching'|'Updating'|'Ready'|'Terminating'|'Terminated',
'AbortableOperationInProgress': True|False,
'Health': 'Green'|'Yellow'|'Red'|'Grey',
'Resources': {
'LoadBalancer': {
'LoadBalancerName': 'string',
'Domain': 'string',
'Listeners': [
{
'Protocol': 'string',
'Port': 123
},
]
}
},
'Tier': {
'Name': 'string',
'Type': 'string',
'Version': 'string'
}
}
Response Structure
|
validate_configuration_settings
(**kwargs)¶Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.
This action returns a list of messages indicating any errors or warnings associated with the selection of option values.
Request Syntax
response = client.validate_configuration_settings(
ApplicationName='string',
TemplateName='string',
EnvironmentName='string',
OptionSettings=[
{
'ResourceName': 'string',
'Namespace': 'string',
'OptionName': 'string',
'Value': 'string'
},
]
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'Messages': [
{
'Message': 'string',
'Severity': 'error'|'warning',
'Namespace': 'string',
'OptionName': 'string'
},
]
}
Response Structure
|
The available paginators are:
ElasticBeanstalk.Paginator.
describe_events
¶paginator = client.get_paginator('describe_events')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from ElasticBeanstalk.Client.describe_events()
.
Request Syntax
response_iterator = paginator.paginate(
ApplicationName='string',
VersionLabel='string',
TemplateName='string',
EnvironmentId='string',
EnvironmentName='string',
RequestId='string',
Severity='TRACE'|'DEBUG'|'INFO'|'WARN'|'ERROR'|'FATAL',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Parameters: |
|
---|---|
Return type: | dict |
Returns: | Response Syntax {
'Events': [
{
'EventDate': datetime(2015, 1, 1),
'Message': 'string',
'ApplicationName': 'string',
'VersionLabel': 'string',
'TemplateName': 'string',
'EnvironmentName': 'string',
'RequestId': 'string',
'Severity': 'TRACE'|'DEBUG'|'INFO'|'WARN'|'ERROR'|'FATAL'
},
],
}
Response Structure
|